/*
 * SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file OpGaussianNoise.h
 *
 * @brief Defines types and functions to handle the GaussianNoise operation.
 * @defgroup NVCV_C_ALGORITHM_GAUSSIAN_NOISE GaussianNoise
 * @{
 */

#ifndef CVCUDA_GAUSSIAN_NOISE_H
#define CVCUDA_GAUSSIAN_NOISE_H

#include "Operator.h"
#include "Types.h"
#include "detail/Export.h"

#include <cuda_runtime.h>
#include <nvcv/ImageBatch.h>
#include <nvcv/Status.h>
#include <nvcv/Tensor.h>

#ifdef __cplusplus
extern "C"
{
#endif

/* Constructs and an instance of the GaussianNoise operator.
 *
 * @param [out] handle Where the image instance handle will be written to.
 *                     + Must not be NULL.
 *
 * @param [in] maxBatchSize the maximum batch size.
 *
 * @retval #NVCV_ERROR_INVALID_ARGUMENT Handle is null.
 * @retval #NVCV_ERROR_OUT_OF_MEMORY    Not enough memory to create the operator.
 * @retval #NVCV_SUCCESS                Operation executed successfully.
*/

CVCUDA_PUBLIC NVCVStatus cvcudaGaussianNoiseCreate(NVCVOperatorHandle *handle, int maxBatchSize);

/* Executes the GaussianNoise operation on the given cuda stream. This operation does not
 *  wait for completion.
 *
 *  Limitations:
 *
 *  Input:
 *       Data Layout:    [kNHWC, kHWC]
 *       Channels:       [1, 2, 3, 4]
 *
 *       Data Type      | Allowed
 *       -------------- | -------------
 *       8bit  Unsigned | Yes
 *       8bit  Signed   | No
 *       16bit Unsigned | Yes
 *       16bit Signed   | Yes
 *       32bit Unsigned | No
 *       32bit Signed   | Yes
 *       32bit Float    | Yes
 *       64bit Float    | No
 *
 *  Output:
 *       Data Layout:    [kNHWC, kHWC]
 *       Channels:       [1, 2, 3, 4]
 *
 *       Data Type      | Allowed
 *       -------------- | -------------
 *       8bit  Unsigned | Yes
 *       8bit  Signed   | No
 *       16bit Unsigned | Yes
 *       16bit Signed   | Yes
 *       32bit Unsigned | No
 *       32bit Signed   | Yes
 *       32bit Float    | Yes
 *       64bit Float    | No
 *
 *  Input/Output dependency
 *
 *       Property      |  Input == Output
 *      -------------- | -------------
 *       Data Layout   | Yes
 *       Data Type     | Yes
 *       Number        | Yes
 *       Channels      | Yes
 *       Width         | Yes
 *       Height        | Yes
 *
 *  mu Tensor
 *
 *      Must be 'N' (dim = 1) with N = batch size.
 *      Data Type must be 32bit Float.
 *      DataType must be TYPE_F32.
 *
 *  sigma Tensor
 *
 *      Must be 'N' (dim = 1) with N = batch size.
 *      Data Type must be 32bit Float.
 *      DataType must be TYPE_F32.
 *
 *
 * @param [in] handle Handle to the operator.
 *                    + Must not be NULL.
 * @param [in] stream Handle to a valid CUDA stream.
 *
 * @param [in] in input image batch.
 *
 * @param [out] out output image batch.
 *
 * @param [in] mu an array of size batch that gives the mu value for gaussian noise.
 *
 * @param [in] sigma an array of size batch that gives the sigma value for gaussian noise.
 *
 * @param [in] per_channel whether to add the same noise for all channels.
 *
 * @param [in] seed for random numbers
 *
 * @retval #NVCV_ERROR_INVALID_ARGUMENT Some parameter is outside valid range.
 * @retval #NVCV_ERROR_INTERNAL         Internal error in the operator, invalid types passed in.
 * @retval #NVCV_SUCCESS                Operation executed successfully.
*/
/** @{ */

CVCUDA_PUBLIC NVCVStatus cvcudaGaussianNoiseSubmit(NVCVOperatorHandle handle, cudaStream_t stream, NVCVTensorHandle in,
                                                   NVCVTensorHandle out, NVCVTensorHandle mu, NVCVTensorHandle sigma,
                                                   int8_t per_channel, unsigned long long seed);

CVCUDA_PUBLIC NVCVStatus cvcudaGaussianNoiseVarShapeSubmit(NVCVOperatorHandle handle, cudaStream_t stream,
                                                           NVCVImageBatchHandle in, NVCVImageBatchHandle out,
                                                           NVCVTensorHandle mu, NVCVTensorHandle sigma,
                                                           int8_t per_channel, unsigned long long seed);

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* CVCUDA_GAUSSIAN_NOISE_H */
